home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / u_man / cat1 / get.z / get
Encoding:
Text File  |  2002-10-03  |  25.1 KB  |  466 lines

  1.  
  2.  
  3.  
  4. GGGGEEEETTTT((((1111))))                                                                  GGGGEEEETTTT((((1111))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      get - get a version of an SCCS file
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      ggggeeeetttt [----rrrr SID] [----cccc cutoff] [----iiii list] [----xxxx list] [----wwww string] [----aaaa seq-no.]
  13.      [----kkkk] [----eeee] [----llll[pppp] [----LLLL] [----pppp] [----mmmm] [----nnnn] [----ssss] [----bbbb] [----gggg] [----tttt] file ...
  14.  
  15. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  16.      _g_e_t generates an ASCII text file from each named SCCS file according to
  17.      the specifications given by its keyletter arguments, which begin with ----.
  18.      The arguments may be specified in any order, but all keyletter arguments
  19.      apply to all named SCCS files.  If a directory is named, _g_e_t behaves as
  20.      though each file in the directory were specified as a named file, except
  21.      that non-SCCS files (last component of the path name does not begin with
  22.      ssss....)  and unreadable files are silently ignored.  If a name of ---- is given,
  23.      the standard input is read; each line of the standard input is taken to
  24.      be the name of an SCCS file to be processed.  Again, non-SCCS files and
  25.      unreadable files are silently ignored.
  26.  
  27.      The generated text is normally written into a file called the _g-_f_i_l_e
  28.      whose name is derived from the SCCS file name by simply removing the
  29.      leading ssss....; (see also _F_I_L_E_S, below).
  30.  
  31.      Each of the keyletter arguments is explained below as though only one
  32.      SCCS file is to be processed, but the effects of any keyletter argument
  33.      applies independently to each named file.
  34.  
  35.           ----rrrr_S_I_D      The _SCCS _I_Dentification string (SID) of the version
  36.                      (delta) of an SCCS file to be retrieved.  Table~1 below
  37.                      shows, for the most useful cases, what version of an SCCS
  38.                      file is retrieved (as well as the SID of the version to
  39.                      be eventually created by _d_e_l_t_a(1) if the ----eeee keyletter is
  40.                      also used), as a function of the SID specified.
  41.  
  42.           ----cccc_c_u_t_o_f_f   _C_u_t_o_f_f date-time, in the form:
  43.  
  44.                           YY[MM[DD[HH[MM[SS]]]]]
  45.  
  46.                      No changes (deltas) to the SCCS file which were created
  47.                      after the specified _c_u_t_o_f_f date-time are included in the
  48.                      generated ASCII text file.  Units omitted from the date-
  49.                      time default to their maximum possible values; that is,
  50.                      ----cccc7777555500002222 is equivalent to ----cccc777755550000222222228888222233335555999955559999.  The values of
  51.                      00-38 for YY indicate 2000-2038.  YY values between 39
  52.                      and 69 are not permitted.  Any number of non-numeric
  53.                      characters may separate the various 2-digit pieces of the
  54.                      _c_u_t_o_f_f date-time.  This feature allows one to specify a
  55.                      _c_u_t_o_f_f date in the form:  "----cccc77777777////2222////2222 9999::::22222222::::22225555".  Note that
  56.                      this implies that one may use the %E% and %U%
  57.                      identification keywords (see below) for nested _g_e_t_s
  58.                      within, say the input to a _s_e_n_d(1C) command:
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. GGGGEEEETTTT((((1111))))                                                                  GGGGEEEETTTT((((1111))))
  71.  
  72.  
  73.  
  74.                           ~!get  "-c%E%  %U%"  s.file
  75.  
  76.           ----iiii_l_i_s_t     A _l_i_s_t of deltas to be included (forced to be applied) in
  77.                      the creation of the generated file.  The _l_i_s_t has the
  78.                      following syntax:
  79.  
  80.                           <list> ::= <range> | <list> , <range>
  81.                           <range> ::= SID | SID - SID
  82.  
  83.                      SID, the SCCS Identification of a delta, may be in any
  84.                      form shown in the ``SID Specified'' column of Table 1.
  85.  
  86.           ----xxxx_l_i_s_t     A _l_i_s_t of deltas to be excluded in the creation of the
  87.                      generated file.  See the ----iiii keyletter for the _l_i_s_t
  88.                      format.
  89.  
  90.           ----eeee         Indicates that the _g_e_t is for the purpose of editing or
  91.                      making a change (delta) to the SCCS file via a subsequent
  92.                      use of _d_e_l_t_a(1).  The ----eeee keyletter used in a _g_e_t for a
  93.                      particular version (SID) of the SCCS file prevents
  94.                      further _g_e_ts for editing on the same SID until _d_e_l_t_a is
  95.                      executed or the jjjj (joint edit) flag is set in the SCCS
  96.                      file [see _a_d_m_i_n(1)].  Concurrent use of ggggeeeetttt ----eeee for
  97.                      different SIDs is always allowed.
  98.  
  99.                      If the _g-_f_i_l_e generated by _g_e_t with an ----eeee keyletter is
  100.                      accidentally ruined in the process of editing it, it may
  101.                      be regenerated by re-executing the _g_e_t command with the
  102.                      ----kkkk keyletter in place of the ----eeee keyletter.
  103.  
  104.                      SCCS file protection specified via the ceiling, floor,
  105.                      and authorized user list stored in the SCCS file [see
  106.                      _a_d_m_i_n(1)] are enforced when the ----eeee keyletter is used.
  107.  
  108.           ----bbbb         Used with the ----eeee keyletter to indicate that the new delta
  109.                      should have an SID in a new branch as shown in Table 1.
  110.                      This keyletter is ignored if the bbbb flag is not present in
  111.                      the file [see _a_d_m_i_n(1)] or if the retrieved _d_e_l_t_a is not
  112.                      a leaf _d_e_l_t_a.  (A leaf _d_e_l_t_a is one that has no
  113.                      successors on the SCCS file tree.)
  114.                      Note: A branch _d_e_l_t_a may always be created from a non-
  115.                      leaf _d_e_l_t_a.  Partial SIDs are interpreted as shown in the
  116.                      ``SID Retrieved'' column of Table 1.
  117.  
  118.           ----kkkk         Suppresses replacement of identification keywords (see
  119.                      below) in the retrieved text by their value.  The ----kkkk
  120.                      keyletter is implied by the ----eeee keyletter.
  121.  
  122.           ----llll[pppp]      Causes a delta summary to be written into an _l-_f_i_l_e.  If
  123.                      ----llllpppp is used then an _l-_f_i_l_e is not created; the delta
  124.                      summary is written on the standard output instead.  See
  125.                      _F_I_L_E_S for the format of the _l-_f_i_l_e.
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. GGGGEEEETTTT((((1111))))                                                                  GGGGEEEETTTT((((1111))))
  137.  
  138.  
  139.  
  140.           ----LLLL         Equivalent to -lp.
  141.  
  142.           ----pppp         Causes the text retrieved from the SCCS file to be
  143.                      written on the standard output.  No _g-_f_i_l_e is created.
  144.                      All output which normally goes to the standard output
  145.                      goes to file descriptor 2 instead, unless the ----ssss
  146.                      keyletter is used, in which case it disappears.
  147.  
  148.           ----ssss         Suppresses all output normally written on the standard
  149.                      output.  However, fatal error messages (which always go
  150.                      to file descriptor 2) remain unaffected.
  151.  
  152.           ----mmmm         Causes each text line retrieved from the SCCS file to be
  153.                      preceded by the SID of the delta that inserted the text
  154.                      line in the SCCS file.  The format is:  SID, followed by
  155.                      a horizontal tab, followed by the text line.
  156.  
  157.           ----nnnn         Causes each generated text line to be preceded with the
  158.                      %M% identification keyword value (see below).  The format
  159.                      is:  %M% value, followed by a horizontal tab, followed by
  160.                      the text line.  When both the ----mmmm and ----nnnn keyletters are
  161.                      used, the format is:  %M% value, followed by a horizontal
  162.                      tab, followed by the ----mmmm keyletter generated format.
  163.  
  164.           ----gggg         Suppresses the actual retrieval of text from the SCCS
  165.                      file.  It is primarily used to generate an _l-_f_i_l_e, or to
  166.                      verify the existence of a particular SID.
  167.  
  168.           ----tttt         Used to access the most recently created delta in a given
  169.                      release (e.g., ----rrrr1111), or release and level (e.g., ----rrrr1111....2222).
  170.  
  171.           ----wwww _s_t_r_i_n_g  Substitute _s_t_r_i_n_g for all occurrences of %W% when getting
  172.                      the file.
  173.  
  174.           ----aaaa_s_e_q-_n_o.  The delta sequence number of the SCCS file delta
  175.                      (version) to be retrieved [see _s_c_c_s_f_i_l_e(5)].  This
  176.                      keyletter is used by the _c_o_m_b(1) command; it is not a
  177.                      generally useful keyletter.  If both the ----rrrr and ----aaaa
  178.                      keyletters are specified, only the ----aaaa keyletter is used.
  179.                      Care should be taken when using the ----aaaa keyletter in
  180.                      conjunction with the ----eeee keyletter, as the SID of the
  181.                      delta to be created may not be what one expects.  The ----rrrr
  182.                      keyletter can be used with the ----aaaa and ----eeee keyletters to
  183.                      control the naming of the SID of the delta to be created.
  184.  
  185.      For each file processed, _g_e_t responds (on the standard output) with the
  186.      SID being accessed and with the number of lines retrieved from the SCCS
  187.      file.
  188.  
  189.      If the ----eeee keyletter is used, the SID of the delta to be made appears
  190.      after the SID accessed and before the number of lines generated.  If
  191.      there is more than one named file or if a directory or standard input is
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. GGGGEEEETTTT((((1111))))                                                                  GGGGEEEETTTT((((1111))))
  203.  
  204.  
  205.  
  206.      named, each file name is printed (preceded by a new-line) before it is
  207.      processed.  If the ----iiii keyletter is used included deltas are listed
  208.      following the notation ``Included''; if the ----xxxx keyletter is used,
  209.      excluded deltas are listed following the notation ``Excluded''.
  210.  
  211.  
  212.              TABLE 1. Determination of SCCS Identification String
  213.    ________________________________________________________________________
  214.      SID*      ----bbbb Keyletter        Other            SID       SID of Delta
  215.    Specified      Used|-          Conditions      Retrieved   to be Created
  216.    ________________________________________________________________________
  217.    none|=            no        R defaults to mR   mR.mL       mR.(mL+1)
  218.    ________________________________________________________________________
  219.    none|=           yes        R defaults to mR   mR.mL       mR.mL.(mB+1).1
  220.    ________________________________________________________________________
  221.    R                no        R > mR             mR.mL       R.1***
  222.    ________________________________________________________________________
  223.    R                no        R = mR             mR.mL       mR.(mL+1)
  224.    ________________________________________________________________________
  225.    R               yes        R > mR             mR.mL       mR.mL.(mB+1).1
  226.    ________________________________________________________________________
  227.    R               yes        R = mR             mR.mL       mR.mL.(mB+1).1
  228.    ________________________________________________________________________
  229.                               R < mR and
  230.    R                -         R does _n_o_t exist   hR.mL**     hR.mL.(mB+1).1
  231.    ________________________________________________________________________
  232.                               Trunk succ.#
  233.                               in release > R
  234.    R                -         and R exists       R.mL        R.mL.(mB+1).1
  235.  
  236.    ________________________________________________________________________
  237.    R.L              no        No trunk succ.     R.L         R.(L+1)
  238.    ________________________________________________________________________
  239.    R.L             yes        No trunk succ.     R.L         R.L.(mB+1).1
  240.    ________________________________________________________________________
  241.                               Trunk succ.
  242.    R.L              -         in release _> R     R.L         R.L.(mB+1).1
  243.    ________________________________________________________________________
  244.    R.L.B            no        No branch succ.    R.L.B.mS    R.L.B.(mS+1)
  245.    ________________________________________________________________________
  246.    R.L.B           yes        No branch succ.    R.L.B.mS    R.L.(mB+1).1
  247.    ________________________________________________________________________
  248.    R.L.B.S          no        No branch succ.    R.L.B.S     R.L.B.(S+1)
  249.    ________________________________________________________________________
  250.    R.L.B.S         yes        No branch succ.    R.L.B.S     R.L.(mB+1).1
  251.    ________________________________________________________________________
  252.    R.L.B.S          -         Branch succ.       R.L.B.S     R.L.(mB+1).1
  253.    ________________________________________________________________________
  254.  
  255.  
  256.      *     ``R'', ``L'', ``B'', and ``S'' are the ``release'', ``level'',
  257.            ``branch'', and ``sequence'' components of the SID, respectively;
  258.            ``m'' means ``maximum''.  Thus, for example, ``R.mL'' means ``the
  259.  
  260.  
  261.  
  262.                                                                         PPPPaaaaggggeeee 4444
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269. GGGGEEEETTTT((((1111))))                                                                  GGGGEEEETTTT((((1111))))
  270.  
  271.  
  272.  
  273.            maximum level number within release R''; ``R.L.(mB+1).1'' means
  274.            ``the first sequence number on the _n_e_w branch (i.e., maximum branch
  275.            number plus one) of level L within release R''.  Note that if the
  276.            SID specified is of the form ``R.L'', ``R.L.B'', or ``R.L.B.S'',
  277.            each of the specified components _m_u_s_t exist.
  278.      **    ``hR'' is the highest _e_x_i_s_t_i_n_g release that is lower than the
  279.            specified, _n_o_n_e_x_i_s_t_e_n_t, release R.
  280.      ***   This is used to force creation of the _f_i_r_s_t delta in a _n_e_w release.
  281.      #     Successor.
  282.      |-     The ----bbbb keyletter is effective only if the bbbb flag [see _a_d_m_i_n(1)] is
  283.            present in the file.  An entry of ---- means ``irrelevant''.
  284.      |=     This case applies if the dddd (default SID) flag is _n_o_t present in the
  285.            file.  If the dddd flag _i_s present in the file, then the SID obtained
  286.            from the dddd flag is interpreted as if it had been specified on the
  287.            command line.  Thus, one of the other cases in this table applies.
  288.  
  289. IIIIDDDDEEEENNNNTTTTIIIIFFFFIIIICCCCAAAATTTTIIIIOOOONNNN KKKKEEEEYYYYWWWWOOOORRRRDDDDSSSS
  290.      Identifying information is inserted into the text retrieved from the SCCS
  291.      file by replacing _i_d_e_n_t_i_f_i_c_a_t_i_o_n _k_e_y_w_o_r_d_s with their value wherever they
  292.      occur.  The following keywords may be used in the text stored in an SCCS
  293.      file:
  294.  
  295.      _K_e_y_w_o_r_d   _V_a_l_u_e
  296.      %%%%MMMM%%%%       Module name:  either the value of the mmmm flag in the file [see
  297.                _a_d_m_i_n(1)], or if absent, the name of the SCCS file with the
  298.                leading ssss.... removed.
  299.      %%%%IIII%%%%       SCCS identification (SID) (%R%.%L%.%B%.%S%) of the retrieved
  300.                text.
  301.      %%%%RRRR%%%%       Release.
  302.      %%%%LLLL%%%%       Level.
  303.      %%%%BBBB%%%%       Branch.
  304.      %%%%SSSS%%%%       Sequence.
  305.      %%%%DDDD%%%%       Current date (YY/MM/DD).
  306.      %%%%HHHH%%%%       Current date (MM/DD/YY).
  307.      %%%%TTTT%%%%       Current time (HH:MM:SS).
  308.      %%%%EEEE%%%%       Date newest applied delta was created (YY/MM/DD).
  309.      %%%%GGGG%%%%       Date newest applied delta was created (MM/DD/YY).
  310.      %%%%UUUU%%%%       Time newest applied delta was created (HH:MM:SS).
  311.      %%%%YYYY%%%%       Module type:  value of the tttt flag in the SCCS file [see
  312.                _a_d_m_i_n(1)].
  313.      %%%%FFFF%%%%       SCCS file name.
  314.      %%%%PPPP%%%%       Fully qualified SCCS file name.
  315.      %%%%QQQQ%%%%       The value of the qqqq flag in the file [see _a_d_m_i_n(1)].
  316.      %%%%CCCC%%%%       Current line number.  This keyword is intended for identifying
  317.                messages output by the program such as ``this should not have
  318.                happened'' type errors.  It is _n_o_t intended to be used on every
  319.                line to provide sequence numbers.
  320.      %%%%ZZZZ%%%%       The 4-character string @@@@((((####)))) recognizable by _w_h_a_t(1).
  321.      %%%%WWWW%%%%       A shorthand notation for constructing _w_h_a_t(1) strings for UNIX
  322.                system program files.  %W% = %Z%%M%<horizontal-tab>%I%
  323.  
  324.  
  325.  
  326.  
  327.  
  328.                                                                         PPPPaaaaggggeeee 5555
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335. GGGGEEEETTTT((((1111))))                                                                  GGGGEEEETTTT((((1111))))
  336.  
  337.  
  338.  
  339.      %%%%AAAA%%%%       Another shorthand notation for constructing _w_h_a_t(1) strings for
  340.                non-UNIX system program files.
  341.                %A% = %Z%%Y% %M% %I%%Z%
  342.  
  343.      Several auxiliary files may be created by _g_e_t.  These files are known
  344.      generically as the _g-_f_i_l_e, _l-_f_i_l_e, _p-_f_i_l_e, and _z-_f_i_l_e.  The letter before
  345.      the hyphen is called the tag.  An auxiliary file name is formed from the
  346.      SCCS file name:  the last component of all SCCS file names must be of the
  347.      form ssss...._m_o_d_u_l_e-_n_a_m_e, the auxiliary files are named by replacing the
  348.      leading ssss with the tag.  The _g-_f_i_l_e is an exception to this scheme:  the
  349.      _g-_f_i_l_e is named by removing the ssss.... prefix.  For example, ssss....xxxxyyyyzzzz....cccc, the
  350.      auxiliary file names would be xxxxyyyyzzzz....cccc, llll....xxxxyyyyzzzz....cccc, pppp....xxxxyyyyzzzz....cccc, and zzzz....xxxxyyyyzzzz....cccc,
  351.      respectively.
  352.  
  353.      The _g-_f_i_l_e, which contains the generated text, is created in the current
  354.      directory (unless the ----pppp keyletter is used).  A _g-_f_i_l_e is created in all
  355.      cases, whether or not any lines of text were generated by the _g_e_t.  It is
  356.      owned by the real user.  If the ----kkkk keyletter is used or implied its mode
  357.      is 644; otherwise its mode is 444.  Only the real user need have write
  358.      permission in the current directory.
  359.  
  360.      The _l-_f_i_l_e contains a table showing which deltas were applied in
  361.      generating the retrieved text.  The _l-_f_i_l_e is created in the current
  362.      directory if the ----llll keyletter is used; its mode is 444 and it is owned by
  363.      the real user.  Only the real user need have write permission in the
  364.      current directory.
  365.  
  366.      Lines in the _l-_f_i_l_e have the following format:
  367.  
  368.           a.   A blank character if the delta was applied;
  369.                **** otherwise.
  370.           b.   A blank character if the delta was applied or was not applied
  371.                and ignored;
  372.                **** if the delta was not applied and was not ignored.
  373.           c.   A code indicating a ``special'' reason why the delta was or was
  374.                not applied:
  375.                     ``I'': Included.
  376.                     ``X'': Excluded.
  377.                     ``C'': Cut off (by a ----cccc keyletter).
  378.           d.   Blank.
  379.           e.   SCCS identification (SID).
  380.           f.   Tab character.
  381.           g.   Date and time (in the form YY/MM/DD HH:MM:SS) of creation.
  382.           h.   Blank.
  383.           i.   Login name of person who created _d_e_l_t_a.
  384.  
  385.           The comments and MMMMRRRR data follow on subsequent lines, indented one
  386.           horizontal tab character.  A blank line terminates each entry.
  387.  
  388.      The _p-_f_i_l_e is used to pass information resulting from a _g_e_t with an ----eeee
  389.      keyletter along to _d_e_l_t_a.  Its contents are also used to prevent a
  390.      subsequent execution of _g_e_t with an ----eeee keyletter for the same SID until
  391.  
  392.  
  393.  
  394.                                                                         PPPPaaaaggggeeee 6666
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401. GGGGEEEETTTT((((1111))))                                                                  GGGGEEEETTTT((((1111))))
  402.  
  403.  
  404.  
  405.      _d_e_l_t_a is executed or the joint edit flag, jjjj, [see _a_d_m_i_n(1)] is set in the
  406.      SCCS file.  The _p-_f_i_l_e is created in the directory containing the SCCS
  407.      file and the effective user must have write permission in that directory.
  408.      Its mode is 644 and it is owned by the effective user.  The format of the
  409.      _p-_f_i_l_e is:  the gotten SID, followed by a blank, followed by the SID that
  410.      the new delta will have when it is made, followed by a blank, followed by
  411.      the login name of the real user, followed by a blank, followed by the
  412.      date-time the _g_e_t was executed, followed by a blank and the ----iiii keyletter
  413.      argument if it was present, followed by a blank and the ----xxxx keyletter
  414.      argument if it was present, followed by a new-line.  There can be an
  415.      arbitrary number of lines in the _p-_f_i_l_e at any time; no two lines can
  416.      have the same new delta SID.
  417.  
  418.      The _z-_f_i_l_e serves as a _l_o_c_k-_o_u_t mechanism against simultaneous updates.
  419.      Its contents are the binary (2 bytes) process ID of the command (i.e.,
  420.      _g_e_t) that created it.  The _z-_f_i_l_e is created in the directory containing
  421.      the SCCS file for the duration of _g_e_t.  The same protection restrictions
  422.      as those for the _p-_f_i_l_e apply for the _z-_f_i_l_e.  The _z-_f_i_l_e is created mode
  423.      444.
  424.  
  425. FFFFIIIILLLLEEEESSSS
  426.      g-file           Existed before the execution of _d_e_l_t_a; removed after
  427.                       completion of _d_e_l_t_a.
  428.      p-file           Existed before the execution of _d_e_l_t_a; may exist after
  429.                       completion of _d_e_l_t_a.
  430.      q-file           Created during the execution of _d_e_l_t_a; removed after
  431.                       completion of _d_e_l_t_a.
  432.      x-file           Created during the execution of _d_e_l_t_a; renamed to SCCS
  433.                       file after completion of _d_e_l_t_a.
  434.      z-file           Created during the execution of _d_e_l_t_a; removed during
  435.                       the execution of _d_e_l_t_a.
  436.      d-file           Created during the execution of _d_e_l_t_a; removed after
  437.                       completion of _d_e_l_t_a.
  438.      /usr/bin/bdiff   Program to compute differences between the ``gotten''
  439.                       file and the _g-_f_i_l_e.
  440.  
  441. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  442.      admin(1), delta(1), help(1), prs(1), what(1)
  443.  
  444. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  445.      Use _h_e_l_p(1) for explanations.
  446.  
  447. BBBBUUUUGGGGSSSS
  448.      If the effective user has write permission (either explicitly or
  449.      implicitly) in the directory containing the SCCS files, but the real user
  450.      does not, then only one file may be named when the ----eeee keyletter is used.
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460.                                                                         PPPPaaaaggggeeee 7777
  461.  
  462.  
  463.  
  464.